<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jetson Inference: videoOptions Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="NVLogo_2D.jpg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Jetson Inference
   </div>
   <div id="projectbrief">DNN Vision Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structvideoOptions.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structvideoOptions-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">videoOptions Struct Reference<div class="ingroups"><a class="el" href="group__util.html">Utilities Library (jetson-utils)</a> &raquo; <a class="el" href="group__video.html">Video Streaming</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="structvideoOptions.html" title="The videoOptions struct contains common settings that are used to configure and query videoSource and...">videoOptions</a> struct contains common settings that are used to configure and query <a class="el" href="classvideoSource.html" title="The videoSource API is for capturing frames from video input devices such as MIPI CSI cameras...">videoSource</a> and <a class="el" href="classvideoOutput.html" title="The videoOutput API is for rendering and transmitting frames to video input devices such as display w...">videoOutput</a> streams.  
 <a href="structvideoOptions.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="videoOptions_8h_source.html">videoOptions.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a4065c77be7f3be75eddfc16b6efb36ed"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36ed">DeviceType</a> { <br />
&#160;&#160;<a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36edabf0f857ba260214fa9fbeda070cf739c">DEVICE_DEFAULT</a> = 0, 
<a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36edac77f0e925955b23e5e4c0bd33b58c40e">DEVICE_V4L2</a>, 
<a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36edad4837999d7b7dbe4b83fc405792fd597">DEVICE_CSI</a>, 
<a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36eda13cb55a7a6d78170f4804dd342b3fc0a">DEVICE_IP</a>, 
<br />
&#160;&#160;<a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36eda14ace01196686e68ba5f6def69f44886">DEVICE_FILE</a>, 
<a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36eda54f0567fd7cf91c40b5e4f13e874da79">DEVICE_DISPLAY</a>
<br />
 }<tr class="memdesc:a4065c77be7f3be75eddfc16b6efb36ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device interface types.  <a href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36ed">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a4065c77be7f3be75eddfc16b6efb36ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f7ae50399192afba10ee226310878b8"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a> { <a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8a75394f2114da6d4d1a690891f70a8b0c">INPUT</a> = 0, 
<a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8a054b71f306226210b98344694784699d">OUTPUT</a>
 }<tr class="memdesc:a7f7ae50399192afba10ee226310878b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Input/Output stream type.  <a href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a7f7ae50399192afba10ee226310878b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd8d5155cc7b38791698b4e89c6a96ee"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96ee">FlipMethod</a> { <br />
&#160;&#160;<a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96eea7c09134804adf49ef07558b78d17f031">FLIP_NONE</a> = 0, 
<a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96eea7e8abbc09244387c1f4607c902976b22">FLIP_COUNTERCLOCKWISE</a>, 
<a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96eeac748895a98407e5dde91b9013611cf19">FLIP_ROTATE_180</a>, 
<a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96eeac19ebe40943991cf5e9fcb69e6c5c3e5">FLIP_CLOCKWISE</a>, 
<br />
&#160;&#160;<a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96eea5d3fdf02e598b86b148161ca516d5162">FLIP_HORIZONTAL</a>, 
<a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96eea42d69b4a7eed239acb174789ce6e22e4">FLIP_UPPER_RIGHT_DIAGONAL</a>, 
<a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96eea4e10ce85a7798075172005bb720912f3">FLIP_VERTICAL</a>, 
<a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96eea089c5073db1bcb4b658be055abdfe9eb">FLIP_UPPER_LEFT_DIAGONAL</a>, 
<br />
&#160;&#160;<a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96eeae1237dbae8c7847640966457de536a96">FLIP_DEFAULT</a> = FLIP_NONE
<br />
 }<tr class="memdesc:acd8d5155cc7b38791698b4e89c6a96ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Settings of the flip method used by MIPI CSI cameras and compressed video inputs.  <a href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96ee">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:acd8d5155cc7b38791698b4e89c6a96ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99a95e988dcf46c0e9177abc7217cf8f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8f">Codec</a> { <br />
&#160;&#160;<a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8fa898a63d4293b84ad77a33ec6bbf89cfc">CODEC_UNKNOWN</a> = 0, 
<a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8fac342da52ac469a843986621ce83a1921">CODEC_RAW</a>, 
<a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8fa27ae05584e47d084cc6460d791b30f78">CODEC_H264</a>, 
<a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8facfa3344671dffa1e70bf03d5ee9e7e65">CODEC_H265</a>, 
<br />
&#160;&#160;<a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8fae1619f6db57624eed45c435ac03f17ae">CODEC_VP8</a>, 
<a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8face0bbd4b6d2c49e63551158e4fbbf890">CODEC_VP9</a>, 
<a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8fa53e71501c4c09e982d2348b84bf275a7">CODEC_MPEG2</a>, 
<a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8fac05b498eb8b7ba169a41317bcf54c21a">CODEC_MPEG4</a>, 
<br />
&#160;&#160;<a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8faa302ddcb4657d7ad35c682ba7b46a144">CODEC_MJPEG</a>
<br />
 }<tr class="memdesc:a99a95e988dcf46c0e9177abc7217cf8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Video codec types.  <a href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8f">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a99a95e988dcf46c0e9177abc7217cf8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afa1cc55ed3beeca6917d90607334079e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#afa1cc55ed3beeca6917d90607334079e">videoOptions</a> ()</td></tr>
<tr class="memdesc:afa1cc55ed3beeca6917d90607334079e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor using default options.  <a href="#afa1cc55ed3beeca6917d90607334079e">More...</a><br /></td></tr>
<tr class="separator:afa1cc55ed3beeca6917d90607334079e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa69a63112b92c4e19a459427329ffd47"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#aa69a63112b92c4e19a459427329ffd47">Print</a> (const char *prefix=NULL) const</td></tr>
<tr class="memdesc:aa69a63112b92c4e19a459427329ffd47"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classLog.html" title="Message logging with a variable level of output and destinations. ">Log</a> the video settings, with an optional prefix label.  <a href="#aa69a63112b92c4e19a459427329ffd47">More...</a><br /></td></tr>
<tr class="separator:aa69a63112b92c4e19a459427329ffd47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afed7ef6f857484d8585760f9316b90e4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#afed7ef6f857484d8585760f9316b90e4">Parse</a> (const char *<a class="el" href="structURI.html">URI</a>, const int argc, char **argv, <a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a> <a class="el" href="structvideoOptions.html#af48a7105c91b415ef158290be02f45e9">ioType</a>)</td></tr>
<tr class="separator:afed7ef6f857484d8585760f9316b90e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1835d463a05df501c7b49e6c3498b3e9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a1835d463a05df501c7b49e6c3498b3e9">Parse</a> (const char *<a class="el" href="structURI.html">URI</a>, const <a class="el" href="classcommandLine.html">commandLine</a> &amp;cmdLine, <a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a> <a class="el" href="structvideoOptions.html#af48a7105c91b415ef158290be02f45e9">ioType</a>)</td></tr>
<tr class="separator:a1835d463a05df501c7b49e6c3498b3e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fc92ca9ada75b62f9d899d1f9f60741"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a7fc92ca9ada75b62f9d899d1f9f60741">Parse</a> (const int argc, char **argv, <a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a> <a class="el" href="structvideoOptions.html#af48a7105c91b415ef158290be02f45e9">ioType</a>, int ioPositionArg=-1)</td></tr>
<tr class="separator:a7fc92ca9ada75b62f9d899d1f9f60741"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abafb7252c68d165e199597ec3cdea30b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#abafb7252c68d165e199597ec3cdea30b">Parse</a> (const <a class="el" href="classcommandLine.html">commandLine</a> &amp;cmdLine, <a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a> <a class="el" href="structvideoOptions.html#af48a7105c91b415ef158290be02f45e9">ioType</a>, int ioPositionArg=-1)</td></tr>
<tr class="separator:abafb7252c68d165e199597ec3cdea30b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a095bf323f30f23060ce3adadfd9c0f2f"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a095bf323f30f23060ce3adadfd9c0f2f">IoTypeToStr</a> (<a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a> type)</td></tr>
<tr class="memdesc:a095bf323f30f23060ce3adadfd9c0f2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert an IoType enum to a string.  <a href="#a095bf323f30f23060ce3adadfd9c0f2f">More...</a><br /></td></tr>
<tr class="separator:a095bf323f30f23060ce3adadfd9c0f2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af15495f79afce20edd2c12343c620073"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#af15495f79afce20edd2c12343c620073">IoTypeFromStr</a> (const char *str)</td></tr>
<tr class="memdesc:af15495f79afce20edd2c12343c620073"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse an IoType enum from a string.  <a href="#af15495f79afce20edd2c12343c620073">More...</a><br /></td></tr>
<tr class="separator:af15495f79afce20edd2c12343c620073"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90479c2aaa46b180855e99be2497dbfc"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a90479c2aaa46b180855e99be2497dbfc">DeviceTypeToStr</a> (<a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36ed">DeviceType</a> type)</td></tr>
<tr class="memdesc:a90479c2aaa46b180855e99be2497dbfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a DeviceType enum to a string.  <a href="#a90479c2aaa46b180855e99be2497dbfc">More...</a><br /></td></tr>
<tr class="separator:a90479c2aaa46b180855e99be2497dbfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a339d348d2b5262987e462f1d42fa4466"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36ed">DeviceType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a339d348d2b5262987e462f1d42fa4466">DeviceTypeFromStr</a> (const char *str)</td></tr>
<tr class="memdesc:a339d348d2b5262987e462f1d42fa4466"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse a DeviceType enum from a string.  <a href="#a339d348d2b5262987e462f1d42fa4466">More...</a><br /></td></tr>
<tr class="separator:a339d348d2b5262987e462f1d42fa4466"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e3de6bbada14e01a36905b8311ef235"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a7e3de6bbada14e01a36905b8311ef235">FlipMethodToStr</a> (<a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96ee">FlipMethod</a> flip)</td></tr>
<tr class="memdesc:a7e3de6bbada14e01a36905b8311ef235"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a FlipMethod enum to a string.  <a href="#a7e3de6bbada14e01a36905b8311ef235">More...</a><br /></td></tr>
<tr class="separator:a7e3de6bbada14e01a36905b8311ef235"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8611c0e59fd292f23ca555f2b5ffd0aa"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96ee">FlipMethod</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a8611c0e59fd292f23ca555f2b5ffd0aa">FlipMethodFromStr</a> (const char *str)</td></tr>
<tr class="memdesc:a8611c0e59fd292f23ca555f2b5ffd0aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse a FlipMethod enum from a string.  <a href="#a8611c0e59fd292f23ca555f2b5ffd0aa">More...</a><br /></td></tr>
<tr class="separator:a8611c0e59fd292f23ca555f2b5ffd0aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3c2c3c26b2352a4f883ba5628049a33"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#ae3c2c3c26b2352a4f883ba5628049a33">CodecToStr</a> (<a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8f">Codec</a> <a class="el" href="structvideoOptions.html#a7570676849d4971e061170b755f7cb71">codec</a>)</td></tr>
<tr class="memdesc:ae3c2c3c26b2352a4f883ba5628049a33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a Codec enum to a string.  <a href="#ae3c2c3c26b2352a4f883ba5628049a33">More...</a><br /></td></tr>
<tr class="separator:ae3c2c3c26b2352a4f883ba5628049a33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9019047206c44b0bb55d120a9c8e8fc1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8f">Codec</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a9019047206c44b0bb55d120a9c8e8fc1">CodecFromStr</a> (const char *str)</td></tr>
<tr class="memdesc:a9019047206c44b0bb55d120a9c8e8fc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse a Codec enum from a string.  <a href="#a9019047206c44b0bb55d120a9c8e8fc1">More...</a><br /></td></tr>
<tr class="separator:a9019047206c44b0bb55d120a9c8e8fc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a1e904a117abb3b703f01eaed7fa305f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structURI.html">URI</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a1e904a117abb3b703f01eaed7fa305f2">resource</a></td></tr>
<tr class="memdesc:a1e904a117abb3b703f01eaed7fa305f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The resource <a class="el" href="structURI.html" title="Resource URI of a video device, IP stream, or file/directory. ">URI</a> of the device, IP stream, or file/directory.  <a href="#a1e904a117abb3b703f01eaed7fa305f2">More...</a><br /></td></tr>
<tr class="separator:a1e904a117abb3b703f01eaed7fa305f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c30587a874bb769d7b346ac00cff580"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a5c30587a874bb769d7b346ac00cff580">width</a></td></tr>
<tr class="memdesc:a5c30587a874bb769d7b346ac00cff580"><td class="mdescLeft">&#160;</td><td class="mdescRight">The width of the stream (in pixels).  <a href="#a5c30587a874bb769d7b346ac00cff580">More...</a><br /></td></tr>
<tr class="separator:a5c30587a874bb769d7b346ac00cff580"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66660b049937fd088b5ab29a0aa2187c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a66660b049937fd088b5ab29a0aa2187c">height</a></td></tr>
<tr class="memdesc:a66660b049937fd088b5ab29a0aa2187c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The height of the stream (in pixels).  <a href="#a66660b049937fd088b5ab29a0aa2187c">More...</a><br /></td></tr>
<tr class="separator:a66660b049937fd088b5ab29a0aa2187c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85ceaa18c31e939f92da06027de8dedd"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a85ceaa18c31e939f92da06027de8dedd">frameRate</a></td></tr>
<tr class="memdesc:a85ceaa18c31e939f92da06027de8dedd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The framerate of the stream (the default is 30Hz).  <a href="#a85ceaa18c31e939f92da06027de8dedd">More...</a><br /></td></tr>
<tr class="separator:a85ceaa18c31e939f92da06027de8dedd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec87b064f96732d6d1d8af49483673e6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#aec87b064f96732d6d1d8af49483673e6">bitRate</a></td></tr>
<tr class="memdesc:aec87b064f96732d6d1d8af49483673e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The encoding bitrate for compressed streams (only applies to video codecs like H264/H265).  <a href="#aec87b064f96732d6d1d8af49483673e6">More...</a><br /></td></tr>
<tr class="separator:aec87b064f96732d6d1d8af49483673e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65b80ddd3f3cf0940f18e365fb58270b"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a65b80ddd3f3cf0940f18e365fb58270b">numBuffers</a></td></tr>
<tr class="memdesc:a65b80ddd3f3cf0940f18e365fb58270b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of ring buffers used for threading.  <a href="#a65b80ddd3f3cf0940f18e365fb58270b">More...</a><br /></td></tr>
<tr class="separator:a65b80ddd3f3cf0940f18e365fb58270b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afff91aa102908923622328e9f3ca3b83"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#afff91aa102908923622328e9f3ca3b83">zeroCopy</a></td></tr>
<tr class="memdesc:afff91aa102908923622328e9f3ca3b83"><td class="mdescLeft">&#160;</td><td class="mdescRight">If true, indicates the buffers are allocated in zeroCopy memory that is mapped to both the CPU and GPU.  <a href="#afff91aa102908923622328e9f3ca3b83">More...</a><br /></td></tr>
<tr class="separator:afff91aa102908923622328e9f3ca3b83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8e394eb896dd92fd39c0946c10dd1ea"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#aa8e394eb896dd92fd39c0946c10dd1ea">loop</a></td></tr>
<tr class="memdesc:aa8e394eb896dd92fd39c0946c10dd1ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control the number of loops for <a class="el" href="classvideoSource.html" title="The videoSource API is for capturing frames from video input devices such as MIPI CSI cameras...">videoSource</a> disk-based inputs (for example, the number of times that a video should loop).  <a href="#aa8e394eb896dd92fd39c0946c10dd1ea">More...</a><br /></td></tr>
<tr class="separator:aa8e394eb896dd92fd39c0946c10dd1ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63c0d583c059d4498ba885090dac062e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36ed">DeviceType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a63c0d583c059d4498ba885090dac062e">deviceType</a></td></tr>
<tr class="memdesc:a63c0d583c059d4498ba885090dac062e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates the type of device interface used by this stream.  <a href="#a63c0d583c059d4498ba885090dac062e">More...</a><br /></td></tr>
<tr class="separator:a63c0d583c059d4498ba885090dac062e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af48a7105c91b415ef158290be02f45e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#af48a7105c91b415ef158290be02f45e9">ioType</a></td></tr>
<tr class="memdesc:af48a7105c91b415ef158290be02f45e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates if this stream is an input or an output.  <a href="#af48a7105c91b415ef158290be02f45e9">More...</a><br /></td></tr>
<tr class="separator:af48a7105c91b415ef158290be02f45e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7af22e5cccd15cc2bdf14386f7f34d36"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96ee">FlipMethod</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a7af22e5cccd15cc2bdf14386f7f34d36">flipMethod</a></td></tr>
<tr class="memdesc:a7af22e5cccd15cc2bdf14386f7f34d36"><td class="mdescLeft">&#160;</td><td class="mdescRight">The flip method controls if and how an input frame is flipped/rotated in pre-processing from a MIPI CSI camera or compressed video input.  <a href="#a7af22e5cccd15cc2bdf14386f7f34d36">More...</a><br /></td></tr>
<tr class="separator:a7af22e5cccd15cc2bdf14386f7f34d36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7570676849d4971e061170b755f7cb71"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8f">Codec</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvideoOptions.html#a7570676849d4971e061170b755f7cb71">codec</a></td></tr>
<tr class="memdesc:a7570676849d4971e061170b755f7cb71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates the codec used by the stream.  <a href="#a7570676849d4971e061170b755f7cb71">More...</a><br /></td></tr>
<tr class="separator:a7570676849d4971e061170b755f7cb71"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="structvideoOptions.html" title="The videoOptions struct contains common settings that are used to configure and query videoSource and...">videoOptions</a> struct contains common settings that are used to configure and query <a class="el" href="classvideoSource.html" title="The videoSource API is for capturing frames from video input devices such as MIPI CSI cameras...">videoSource</a> and <a class="el" href="classvideoOutput.html" title="The videoOutput API is for rendering and transmitting frames to video input devices such as display w...">videoOutput</a> streams. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a99a95e988dcf46c0e9177abc7217cf8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99a95e988dcf46c0e9177abc7217cf8f">&#9670;&nbsp;</a></span>Codec</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8f">videoOptions::Codec</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Video codec types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a99a95e988dcf46c0e9177abc7217cf8fa898a63d4293b84ad77a33ec6bbf89cfc"></a>CODEC_UNKNOWN&#160;</td><td class="fielddoc"><p>Unknown/unsupported codec. </p>
</td></tr>
<tr><td class="fieldname"><a id="a99a95e988dcf46c0e9177abc7217cf8fac342da52ac469a843986621ce83a1921"></a>CODEC_RAW&#160;</td><td class="fielddoc"><p>Uncompressed (e.g. </p>
<p>RGB) </p>
</td></tr>
<tr><td class="fieldname"><a id="a99a95e988dcf46c0e9177abc7217cf8fa27ae05584e47d084cc6460d791b30f78"></a>CODEC_H264&#160;</td><td class="fielddoc"><p>H.264. </p>
</td></tr>
<tr><td class="fieldname"><a id="a99a95e988dcf46c0e9177abc7217cf8facfa3344671dffa1e70bf03d5ee9e7e65"></a>CODEC_H265&#160;</td><td class="fielddoc"><p>H.265. </p>
</td></tr>
<tr><td class="fieldname"><a id="a99a95e988dcf46c0e9177abc7217cf8fae1619f6db57624eed45c435ac03f17ae"></a>CODEC_VP8&#160;</td><td class="fielddoc"><p>VP8. </p>
</td></tr>
<tr><td class="fieldname"><a id="a99a95e988dcf46c0e9177abc7217cf8face0bbd4b6d2c49e63551158e4fbbf890"></a>CODEC_VP9&#160;</td><td class="fielddoc"><p>VP9. </p>
</td></tr>
<tr><td class="fieldname"><a id="a99a95e988dcf46c0e9177abc7217cf8fa53e71501c4c09e982d2348b84bf275a7"></a>CODEC_MPEG2&#160;</td><td class="fielddoc"><p>MPEG2 (decode only) </p>
</td></tr>
<tr><td class="fieldname"><a id="a99a95e988dcf46c0e9177abc7217cf8fac05b498eb8b7ba169a41317bcf54c21a"></a>CODEC_MPEG4&#160;</td><td class="fielddoc"><p>MPEG4 (decode only) </p>
</td></tr>
<tr><td class="fieldname"><a id="a99a95e988dcf46c0e9177abc7217cf8faa302ddcb4657d7ad35c682ba7b46a144"></a>CODEC_MJPEG&#160;</td><td class="fielddoc"><p>MJPEG. </p>
</td></tr>
</table>

</div>
</div>
<a id="a4065c77be7f3be75eddfc16b6efb36ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4065c77be7f3be75eddfc16b6efb36ed">&#9670;&nbsp;</a></span>DeviceType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36ed">videoOptions::DeviceType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device interface types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4065c77be7f3be75eddfc16b6efb36edabf0f857ba260214fa9fbeda070cf739c"></a>DEVICE_DEFAULT&#160;</td><td class="fielddoc"><p>Unknown interface type. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4065c77be7f3be75eddfc16b6efb36edac77f0e925955b23e5e4c0bd33b58c40e"></a>DEVICE_V4L2&#160;</td><td class="fielddoc"><p>V4L2 webcam (e.g. </p>
<p><code>/dev/video0</code>) </p>
</td></tr>
<tr><td class="fieldname"><a id="a4065c77be7f3be75eddfc16b6efb36edad4837999d7b7dbe4b83fc405792fd597"></a>DEVICE_CSI&#160;</td><td class="fielddoc"><p>MIPI CSI camera. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4065c77be7f3be75eddfc16b6efb36eda13cb55a7a6d78170f4804dd342b3fc0a"></a>DEVICE_IP&#160;</td><td class="fielddoc"><p>IP-based network stream (e.g. </p>
<p>RTP/RTSP) </p>
</td></tr>
<tr><td class="fieldname"><a id="a4065c77be7f3be75eddfc16b6efb36eda14ace01196686e68ba5f6def69f44886"></a>DEVICE_FILE&#160;</td><td class="fielddoc"><p>Disk-based stream from a file or directory of files. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4065c77be7f3be75eddfc16b6efb36eda54f0567fd7cf91c40b5e4f13e874da79"></a>DEVICE_DISPLAY&#160;</td><td class="fielddoc"><p>OpenGL output stream rendered to an attached display. </p>
</td></tr>
</table>

</div>
</div>
<a id="acd8d5155cc7b38791698b4e89c6a96ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd8d5155cc7b38791698b4e89c6a96ee">&#9670;&nbsp;</a></span>FlipMethod</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96ee">videoOptions::FlipMethod</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Settings of the flip method used by MIPI CSI cameras and compressed video inputs. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="acd8d5155cc7b38791698b4e89c6a96eea7c09134804adf49ef07558b78d17f031"></a>FLIP_NONE&#160;</td><td class="fielddoc"><p>Identity (no rotation) </p>
</td></tr>
<tr><td class="fieldname"><a id="acd8d5155cc7b38791698b4e89c6a96eea7e8abbc09244387c1f4607c902976b22"></a>FLIP_COUNTERCLOCKWISE&#160;</td><td class="fielddoc"><p>Rotate counter-clockwise 90 degrees. </p>
</td></tr>
<tr><td class="fieldname"><a id="acd8d5155cc7b38791698b4e89c6a96eeac748895a98407e5dde91b9013611cf19"></a>FLIP_ROTATE_180&#160;</td><td class="fielddoc"><p>Rotate 180 degrees. </p>
</td></tr>
<tr><td class="fieldname"><a id="acd8d5155cc7b38791698b4e89c6a96eeac19ebe40943991cf5e9fcb69e6c5c3e5"></a>FLIP_CLOCKWISE&#160;</td><td class="fielddoc"><p>Rotate clockwise 90 degrees. </p>
</td></tr>
<tr><td class="fieldname"><a id="acd8d5155cc7b38791698b4e89c6a96eea5d3fdf02e598b86b148161ca516d5162"></a>FLIP_HORIZONTAL&#160;</td><td class="fielddoc"><p>Flip horizontally. </p>
</td></tr>
<tr><td class="fieldname"><a id="acd8d5155cc7b38791698b4e89c6a96eea42d69b4a7eed239acb174789ce6e22e4"></a>FLIP_UPPER_RIGHT_DIAGONAL&#160;</td><td class="fielddoc"><p>Flip across upper right/lower left diagonal. </p>
</td></tr>
<tr><td class="fieldname"><a id="acd8d5155cc7b38791698b4e89c6a96eea4e10ce85a7798075172005bb720912f3"></a>FLIP_VERTICAL&#160;</td><td class="fielddoc"><p>Flip vertically. </p>
</td></tr>
<tr><td class="fieldname"><a id="acd8d5155cc7b38791698b4e89c6a96eea089c5073db1bcb4b658be055abdfe9eb"></a>FLIP_UPPER_LEFT_DIAGONAL&#160;</td><td class="fielddoc"><p>Flip across upper left/lower right diagonal. </p>
</td></tr>
<tr><td class="fieldname"><a id="acd8d5155cc7b38791698b4e89c6a96eeae1237dbae8c7847640966457de536a96"></a>FLIP_DEFAULT&#160;</td><td class="fielddoc"><p>Default setting (none) </p>
</td></tr>
</table>

</div>
</div>
<a id="a7f7ae50399192afba10ee226310878b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f7ae50399192afba10ee226310878b8">&#9670;&nbsp;</a></span>IoType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">videoOptions::IoType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Input/Output stream type. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7f7ae50399192afba10ee226310878b8a75394f2114da6d4d1a690891f70a8b0c"></a>INPUT&#160;</td><td class="fielddoc"><p>Input stream (e.g. </p>
<p>camera, video/image file, ect.) </p>
</td></tr>
<tr><td class="fieldname"><a id="a7f7ae50399192afba10ee226310878b8a054b71f306226210b98344694784699d"></a>OUTPUT&#160;</td><td class="fielddoc"><p>Output stream (e.g. </p>
<p>display, video/image file, ect.) </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="afa1cc55ed3beeca6917d90607334079e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa1cc55ed3beeca6917d90607334079e">&#9670;&nbsp;</a></span>videoOptions()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">videoOptions::videoOptions </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor using default options. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9019047206c44b0bb55d120a9c8e8fc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9019047206c44b0bb55d120a9c8e8fc1">&#9670;&nbsp;</a></span>CodecFromStr()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8f">Codec</a> videoOptions::CodecFromStr </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>str</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parse a Codec enum from a string. </p>

</div>
</div>
<a id="ae3c2c3c26b2352a4f883ba5628049a33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3c2c3c26b2352a4f883ba5628049a33">&#9670;&nbsp;</a></span>CodecToStr()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static const char* videoOptions::CodecToStr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8f">Codec</a>&#160;</td>
          <td class="paramname"><em>codec</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Convert a Codec enum to a string. </p>

</div>
</div>
<a id="a339d348d2b5262987e462f1d42fa4466"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a339d348d2b5262987e462f1d42fa4466">&#9670;&nbsp;</a></span>DeviceTypeFromStr()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36ed">DeviceType</a> videoOptions::DeviceTypeFromStr </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>str</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parse a DeviceType enum from a string. </p>

</div>
</div>
<a id="a90479c2aaa46b180855e99be2497dbfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90479c2aaa46b180855e99be2497dbfc">&#9670;&nbsp;</a></span>DeviceTypeToStr()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static const char* videoOptions::DeviceTypeToStr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36ed">DeviceType</a>&#160;</td>
          <td class="paramname"><em>type</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Convert a DeviceType enum to a string. </p>

</div>
</div>
<a id="a8611c0e59fd292f23ca555f2b5ffd0aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8611c0e59fd292f23ca555f2b5ffd0aa">&#9670;&nbsp;</a></span>FlipMethodFromStr()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96ee">FlipMethod</a> videoOptions::FlipMethodFromStr </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>str</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parse a FlipMethod enum from a string. </p>

</div>
</div>
<a id="a7e3de6bbada14e01a36905b8311ef235"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e3de6bbada14e01a36905b8311ef235">&#9670;&nbsp;</a></span>FlipMethodToStr()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static const char* videoOptions::FlipMethodToStr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96ee">FlipMethod</a>&#160;</td>
          <td class="paramname"><em>flip</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Convert a FlipMethod enum to a string. </p>

</div>
</div>
<a id="af15495f79afce20edd2c12343c620073"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af15495f79afce20edd2c12343c620073">&#9670;&nbsp;</a></span>IoTypeFromStr()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a> videoOptions::IoTypeFromStr </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>str</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parse an IoType enum from a string. </p>

</div>
</div>
<a id="a095bf323f30f23060ce3adadfd9c0f2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a095bf323f30f23060ce3adadfd9c0f2f">&#9670;&nbsp;</a></span>IoTypeToStr()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static const char* videoOptions::IoTypeToStr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a>&#160;</td>
          <td class="paramname"><em>type</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Convert an IoType enum to a string. </p>

</div>
</div>
<a id="afed7ef6f857484d8585760f9316b90e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afed7ef6f857484d8585760f9316b90e4">&#9670;&nbsp;</a></span>Parse() <span class="overload">[1/4]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool videoOptions::Parse </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>URI</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const int&#160;</td>
          <td class="paramname"><em>argc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>argv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a>&#160;</td>
          <td class="paramname"><em>ioType</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a1835d463a05df501c7b49e6c3498b3e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1835d463a05df501c7b49e6c3498b3e9">&#9670;&nbsp;</a></span>Parse() <span class="overload">[2/4]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool videoOptions::Parse </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>URI</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcommandLine.html">commandLine</a> &amp;&#160;</td>
          <td class="paramname"><em>cmdLine</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a>&#160;</td>
          <td class="paramname"><em>ioType</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a7fc92ca9ada75b62f9d899d1f9f60741"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fc92ca9ada75b62f9d899d1f9f60741">&#9670;&nbsp;</a></span>Parse() <span class="overload">[3/4]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool videoOptions::Parse </td>
          <td>(</td>
          <td class="paramtype">const int&#160;</td>
          <td class="paramname"><em>argc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>argv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a>&#160;</td>
          <td class="paramname"><em>ioType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>ioPositionArg</em> = <code>-1</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="abafb7252c68d165e199597ec3cdea30b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abafb7252c68d165e199597ec3cdea30b">&#9670;&nbsp;</a></span>Parse() <span class="overload">[4/4]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool videoOptions::Parse </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcommandLine.html">commandLine</a> &amp;&#160;</td>
          <td class="paramname"><em>cmdLine</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a>&#160;</td>
          <td class="paramname"><em>ioType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>ioPositionArg</em> = <code>-1</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="aa69a63112b92c4e19a459427329ffd47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa69a63112b92c4e19a459427329ffd47">&#9670;&nbsp;</a></span>Print()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void videoOptions::Print </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>prefix</em> = <code>NULL</code></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><a class="el" href="classLog.html" title="Message logging with a variable level of output and destinations. ">Log</a> the video settings, with an optional prefix label. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aec87b064f96732d6d1d8af49483673e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec87b064f96732d6d1d8af49483673e6">&#9670;&nbsp;</a></span>bitRate</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t videoOptions::bitRate</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The encoding bitrate for compressed streams (only applies to video codecs like H264/H265). </p>
<p>For <a class="el" href="classvideoOutput.html" title="The videoOutput API is for rendering and transmitting frames to video input devices such as display w...">videoOutput</a> streams, this option can be set from the command line using <code>--bitrate=N</code>. </p><dl class="section note"><dt>Note</dt><dd>the default bitrate for encoding output streams is 4Mbps (target VBR). </dd></dl>

</div>
</div>
<a id="a7570676849d4971e061170b755f7cb71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7570676849d4971e061170b755f7cb71">&#9670;&nbsp;</a></span>codec</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structvideoOptions.html#a99a95e988dcf46c0e9177abc7217cf8f">Codec</a> videoOptions::codec</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Indicates the codec used by the stream. </p>
<p>This is only really applicable to compressed streams, otherwise it will be <code>CODEC_RAW</code>.</p>
<p><a class="el" href="classvideoSource.html" title="The videoSource API is for capturing frames from video input devices such as MIPI CSI cameras...">videoSource</a> input streams will attempt to discover the codec type (i.e. from video file), however RTP streams need this to be explitly set using the <code>--input-codec=xyz</code> option (where <code>xyz</code> is a string like <code>h264</code>, <code>h265</code>, <code>vp8</code>, <code>vp9</code>, <code>mpeg2</code>, <code>mpeg4</code>, or <code>mjpeg</code>).</p>
<p>A compressed <a class="el" href="classvideoOutput.html" title="The videoOutput API is for rendering and transmitting frames to video input devices such as display w...">videoOutput</a> stream will default to H.264 encoding, but can be set using the <code>--output-codec=xyz</code> command line option (same values for <code>xyz</code> as above). </p>

</div>
</div>
<a id="a63c0d583c059d4498ba885090dac062e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63c0d583c059d4498ba885090dac062e">&#9670;&nbsp;</a></span>deviceType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structvideoOptions.html#a4065c77be7f3be75eddfc16b6efb36ed">DeviceType</a> videoOptions::deviceType</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Indicates the type of device interface used by this stream. </p>

</div>
</div>
<a id="a7af22e5cccd15cc2bdf14386f7f34d36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7af22e5cccd15cc2bdf14386f7f34d36">&#9670;&nbsp;</a></span>flipMethod</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structvideoOptions.html#acd8d5155cc7b38791698b4e89c6a96ee">FlipMethod</a> videoOptions::flipMethod</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The flip method controls if and how an input frame is flipped/rotated in pre-processing from a MIPI CSI camera or compressed video input. </p>
<p>Other types of streams will ignore this.</p>
<p>This option can be set from the command line using <code>--flip-method=xyz</code>, where <code>xyz</code> is one of the strings below:</p>
<ul>
<li><code>none</code> (Identity, no rotation)</li>
<li><code>counterclockwise</code> (Rotate counter-clockwise 90 degrees)</li>
<li><code>rotate-180</code> (Rotate 180 degrees)</li>
<li><code>clockwise</code> (Rotate clockwise 90 degrees)</li>
<li><code>horizontal-flip</code> (Flip horizontally)</li>
<li><code>vertical-flip</code> (Flip vertically)</li>
<li><code>upper-right-diagonal</code> (Flip across upper right/lower left diagonal)</li>
<li><code>upper-left-diagonal</code> (Flip across upper left/lower right diagonal) </li>
</ul>

</div>
</div>
<a id="a85ceaa18c31e939f92da06027de8dedd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85ceaa18c31e939f92da06027de8dedd">&#9670;&nbsp;</a></span>frameRate</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float videoOptions::frameRate</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The framerate of the stream (the default is 30Hz). </p>
<p>This option can be set from the command line using <code>--input-rate=N</code> or <code>--output-rate=N</code> for input and output streams, respectively. The <code>--framerate=N</code> option sets it for both. </p>

</div>
</div>
<a id="a66660b049937fd088b5ab29a0aa2187c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66660b049937fd088b5ab29a0aa2187c">&#9670;&nbsp;</a></span>height</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t videoOptions::height</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The height of the stream (in pixels). </p>
<p>This option can be set from the command line using <code>--input-height=N</code> for <a class="el" href="classvideoSource.html" title="The videoSource API is for capturing frames from video input devices such as MIPI CSI cameras...">videoSource</a> streams, or <code>--output-height=N</code> for <a class="el" href="classvideoOutput.html" title="The videoOutput API is for rendering and transmitting frames to video input devices such as display w...">videoOutput</a> streams. </p>

</div>
</div>
<a id="af48a7105c91b415ef158290be02f45e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af48a7105c91b415ef158290be02f45e9">&#9670;&nbsp;</a></span>ioType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structvideoOptions.html#a7f7ae50399192afba10ee226310878b8">IoType</a> videoOptions::ioType</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Indicates if this stream is an input or an output. </p>

</div>
</div>
<a id="aa8e394eb896dd92fd39c0946c10dd1ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8e394eb896dd92fd39c0946c10dd1ea">&#9670;&nbsp;</a></span>loop</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int videoOptions::loop</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Control the number of loops for <a class="el" href="classvideoSource.html" title="The videoSource API is for capturing frames from video input devices such as MIPI CSI cameras...">videoSource</a> disk-based inputs (for example, the number of times that a video should loop). </p>
<p>Other types of streams will ignore it.</p>
<p>The following values are are valid:</p>
<p>-1 = loop forever 0 = don't loop &gt;0 = set number of loops</p>
<p>This option can be set from the command line using <code>--loop=N</code>. </p><dl class="section note"><dt>Note</dt><dd>by default, looping is disabled (set to <code>0</code>). </dd></dl>

</div>
</div>
<a id="a65b80ddd3f3cf0940f18e365fb58270b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65b80ddd3f3cf0940f18e365fb58270b">&#9670;&nbsp;</a></span>numBuffers</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t videoOptions::numBuffers</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The number of ring buffers used for threading. </p>
<p>This option can be set from the command line using <code>--num-buffers=N</code>. </p><dl class="section note"><dt>Note</dt><dd>the default number of ring buffers is 4. </dd></dl>

</div>
</div>
<a id="a1e904a117abb3b703f01eaed7fa305f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e904a117abb3b703f01eaed7fa305f2">&#9670;&nbsp;</a></span>resource</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structURI.html">URI</a> videoOptions::resource</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The resource <a class="el" href="structURI.html" title="Resource URI of a video device, IP stream, or file/directory. ">URI</a> of the device, IP stream, or file/directory. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structURI.html" title="Resource URI of a video device, IP stream, or file/directory. ">URI</a> for details about accepted protocols and <a class="el" href="structURI.html" title="Resource URI of a video device, IP stream, or file/directory. ">URI</a> formats. </dd></dl>

</div>
</div>
<a id="a5c30587a874bb769d7b346ac00cff580"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c30587a874bb769d7b346ac00cff580">&#9670;&nbsp;</a></span>width</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t videoOptions::width</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The width of the stream (in pixels). </p>
<p>This option can be set from the command line using <code>--input-width=N</code> for <a class="el" href="classvideoSource.html" title="The videoSource API is for capturing frames from video input devices such as MIPI CSI cameras...">videoSource</a> streams, or <code>--output-width=N</code> for <a class="el" href="classvideoOutput.html" title="The videoOutput API is for rendering and transmitting frames to video input devices such as display w...">videoOutput</a> streams. </p>

</div>
</div>
<a id="afff91aa102908923622328e9f3ca3b83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afff91aa102908923622328e9f3ca3b83">&#9670;&nbsp;</a></span>zeroCopy</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool videoOptions::zeroCopy</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If true, indicates the buffers are allocated in zeroCopy memory that is mapped to both the CPU and GPU. </p>
<p>Otherwise, the buffers are only accessible from the GPU. </p><dl class="section note"><dt>Note</dt><dd>the default is true (zeroCopy CPU/GPU access enabled). </dd></dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>jetson-utils/<a class="el" href="videoOptions_8h_source.html">videoOptions.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structvideoOptions.html">videoOptions</a></li>
    <li class="footer">Generated on Tue Jul 14 2020 21:59:35 for Jetson Inference by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
